v13.0.0

Compare Source

   🚨 Breaking Changes

• Drop CJS build, now it's ESM-only  -  by @​antfu in https://github.com/vueuse/vueuse/issues/4581 (5e046)

    View changes on GitHub

v12.8.2

Compare Source

   🐞 Bug Fixes

• types: Wrong import path  -  by @​antfu (3f5da)

    View changes on GitHub

v12.8.1

Compare Source

   🐞 Bug Fixes

• useEventSource: Remove readonly to not be breaking  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4645 (79fcb)

    View changes on GitHub

v12.8.0

Compare Source

   🚀 Features

• nuxt: Support wider Nuxt range  -  by @​antfu (c478e)
• types: Deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native  -  by @​ilyaliao and @​antfu in https://github.com/vueuse/vueuse/issues/4636 (7432f)
• useCached: Add options.deepRefs  -  by @​OrbisK and @​antfu in https://github.com/vueuse/vueuse/issues/4591 (9afee)
• useWebSocket: Pass the retried to the autoReconnect.retries  -  by @​9romise and @​OrbisK in https://github.com/vueuse/vueuse/issues/4604 (73e6d)

   🐞 Bug Fixes

• onStartTyping: Incorrect accepted valid characters  -  by @​Bernard-Borg in https://github.com/vueuse/vueuse/issues/4616 (58a3b)
• useAnimate: Correct condition for updating keyframes  -  by @​Mrlilili and liyan1 in https://github.com/vueuse/vueuse/issues/4619 (e8665)
• useClipboard: Unhandled rejection on read permission prompt  -  by @​Vitalis11 in https://github.com/vueuse/vueuse/issues/4615 (a54c4)
• useCssVar: Update variable when initial  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4641 (d680f)
• useDeviceList: AudioInputs doesn't update if camera permission is granted  -  by @​Nikitatopodin and Никита Быковский in https://github.com/vueuse/vueuse/issues/4559 (f9685)
• useScroll: Handle negative scroll values  -  by @​ilyaliao and eavlee in https://github.com/vueuse/vueuse/issues/4613 (4b7ab)
• useWebSocket: Don't call close() on pongTimeout if connection al…  -  by @​Azurency in https://github.com/vueuse/vueuse/issues/4608 (9ba07)

    View changes on GitHub

v12.7.0

Compare Source

   🚀 Features

• useRafFn: Add once option  -  by @​btea in https://github.com/vueuse/vueuse/issues/4583 (3041e)

   🐞 Bug Fixes

• useFetch: Partial overwrite when {combination: 'overwrite'}  -  by @​pkc918 and @​antfu in https://github.com/vueuse/vueuse/issues/4430 (3ca0d)
• useTextareaAutosize: Improve resize handling with requestAnimationFrame  -  by @​ilyaliao, Robin and @​antfu in https://github.com/vueuse/vueuse/issues/4557 (e1a7e)

    View changes on GitHub

v12.6.1

Compare Source

No significant changes

    View changes on GitHub

v12.6.0

Compare Source

   🚀 Features

• createReusableTemplate: Explicit props  -  by @​antfu in https://github.com/vueuse/vueuse/issues/4535 (18031)
• onClickOutside: Add controls  -  by @​sibbng and @​antfu in https://github.com/vueuse/vueuse/issues/4537 (ab116)
• useDateFormat: Add z...zzzz for timezone information  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4553 (cd6d7)
• useElementVisibility: Add once options  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4577 (f2f94)
• useTimtoutFn,useTimeoutPoll: Align behavior  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4543 (64c53)
• watchPausable: Add options.initialState to control the initial active value  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4533 (ceb56)

   🐞 Bug Fixes

• createEventHook: Type check for multiple arguments  -  by @​isimehmeti and @​ilyaliao in https://github.com/vueuse/vueuse/issues/4555 (636b8)
• nuxt: Check if packages exist in any layer  -  by @​dgrayvold in https://github.com/vueuse/vueuse/issues/4571 (45e5c)
• reactiveComputed: Computed fn should be ComputedGetter  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4528 (bea31)
• useAnimate: Clear animate when element is gone  -  by @​babu-ch in https://github.com/vueuse/vueuse/issues/4579 (1a934)
• useCountdown: start() should accept a custom initial value  -  by @​ralacerda in https://github.com/vueuse/vueuse/issues/4554 (93591)
• useCssVar: New Behavior  -  by @​ilyaliao and OrbisK in https://github.com/vueuse/vueuse/issues/4500 (d5dd8)
• useMouse: Check for MouseEvent instead of Touch to work with FF  -  by @​OrbisK and @​antfu in https://github.com/vueuse/vueuse/issues/4457 (ce9e5)
• useSpeechRecognition: Improve start and stop method behavior  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4565 (4f104)

    View changes on GitHub

v12.5.0

Compare Source

   🚀 Features

• More passive event handlers  -  by @​ferferga in https://github.com/vueuse/vueuse/issues/4484 (eddbf)
• Use useEventListener where it was not being used  -  by @​ferferga in https://github.com/vueuse/vueuse/issues/4479 (c6c6e)
• useClipboard: Should fall back to legacy clipboard when read/write fails  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4512 (01acd)
• useCountdown: New function  -  by @​rtugeek, @​huang-julien, Anthony Fu and @​antfu in https://github.com/vueuse/vueuse/issues/4125 (69ced)
• useEventListener: Make all parameters arrayable and reactive  -  by @​ferferga in https://github.com/vueuse/vueuse/issues/4486 (caf08)
• useFetch: Add parameters to the afterFetch and onFetchError  -  by @​tolking and Anthony Fu in https://github.com/vueuse/vueuse/issues/4499 (98a83)
• useFileDialog: Add initialFiles option  -  by @​EvgenyWas in https://github.com/vueuse/vueuse/issues/4509 (8a8d6)

   🐞 Bug Fixes

• debounceFilter: Invoke on maxWait with the latest invoker  -  by @​43081j and @​OrbisK in https://github.com/vueuse/vueuse/issues/4497 (48e0a)
• useMagicKeys: Fix key order issue on first use  -  by @​babu-ch in https://github.com/vueuse/vueuse/issues/4505 (b6947)
• useVirtualList: Allow readonly arrays as input  -  by @​RebeccaStevens in https://github.com/vueuse/vueuse/issues/4504 (f3cc7)

    View changes on GitHub

v12.4.0

Compare Source

   🚀 Features

• Use passive event handlers everywhere is possible  -  by @​ferferga and @​antfu in https://github.com/vueuse/vueuse/issues/4477 (dd316)
• useCloned: Return isModified  -  by @​pkc918 and @​antfu in https://github.com/vueuse/vueuse/issues/4470 (6018c)
• useStorage: Make storage key reactive  -  by @​EvgenyWas and @​antfu in https://github.com/vueuse/vueuse/issues/4464 (eb679)

   🐞 Bug Fixes

• useBluetooth: IsConnected state not changed when disconnected  -  by @​ilyaliao, @​antfu and @​ferferga in https://github.com/vueuse/vueuse/issues/4460 (fcc6e)

    View changes on GitHub

v12.3.0

Compare Source

   🚀 Features

• onElementRemoval: New function, refactor useActiveElement useElementHover  -  by @​ben-lau and @​antfu in https://github.com/vueuse/vueuse/issues/4410 (08cf5)
• router: Support partial transform  -  by @​alexchexes and @​antfu in https://github.com/vueuse/vueuse/issues/4426 (bba3f)
• toArray: New utility function  -  by @​coderwhytop and @​antfu in https://github.com/vueuse/vueuse/issues/4432 (021d0)
• toValue: Deprecate toValue from @vueuse/shared in favor of Vue's native  -  by @​antfu (59f75)
• useElementBounding: Added directive for vElementBounding  -  by @​pkc918 in https://github.com/vueuse/vueuse/issues/4436 (67a9c)
• useMouseInElement: Added directive for vMouseInElement  -  by @​pkc918 in https://github.com/vueuse/vueuse/issues/4438 (34be5)
• useMousePressed: Add onPressed and onReleased as options  -  by @​OrbisK in https://github.com/vueuse/vueuse/issues/4425 (a123a)
• useToNumber: method support custom function  -  by @​btea and @​antfu in https://github.com/vueuse/vueuse/issues/4441 (635bb)
• useWindowScroll: Use useScroll under the hood  -  by @​OrbisK and @​antfu in https://github.com/vueuse/vueuse/issues/4424 (a033e)

   🐞 Bug Fixes

• useAxios: Narrow type of data when initialValue is provided  -  by @​huang-julien and @​antfu in https://github.com/vueuse/vueuse/issues/4419 (8502f)
• useClipboard,useClipboardItems: Avoid running "copied" timeout during initialization  -  by @​Ingramz in https://github.com/vueuse/vueuse/issues/4299 (6860f)
• useDropZone: Validate all file types individually when dropping multiple files  -  by @​LouisMazel in https://github.com/vueuse/vueuse/issues/4325 (b01cf)
• useFocusWithin: Correctly track the state when switching the focus of elements in the same container  -  by @​ben-lau in https://github.com/vueuse/vueuse/issues/4394 (3ca0d)
• useRouteQuery: Differentiate undefined and null when writing value  -  by @​aa-ndrej and @​antfu in https://github.com/vueuse/vueuse/issues/4382 (0cc45)
• useSpeechRecognition: Execute 'start' when not ended  -  by @​byronogis and @​antfu in https://github.com/vueuse/vueuse/issues/4119 (890ab)
• useStorageAsync: Correct initialization when initialValue is getter  -  by @​Mini-ghost and @​antfu in https://github.com/vueuse/vueuse/issues/4452 (e6a17)
• useTimeoutPoll: immediate default value should be true  -  by @​phk422 and @​antfu in https://github.com/vueuse/vueuse/issues/4232 (0450d)
• useTimeoutPoll: Only start by default at client  -  by @​antfu (a5fb0)

    View changes on GitHub

v12.2.0

Compare Source

   🚀 Features

• useArrayDifference: New symmetric option  -  by @​wangliangxin, wangliangxin3 and @​antfu in https://github.com/vueuse/vueuse/issues/4146 (46fdc)
• useEventSource: New autoConnect option to align with useWebSocket  -  by @​ferferga and @​antfu in https://github.com/vueuse/vueuse/issues/4204 (230f8)
• useImage: Support more native option  -  by @​btea and @​antfu in https://github.com/vueuse/vueuse/issues/4173 (4ca72)
• usePreferredReducedTransparency: Add new function  -  by @​huiliangShen and @​antfu in https://github.com/vueuse/vueuse/issues/4201 (34cd7)

   🐞 Bug Fixes

• useWebSocket: Clear retryTimer when connected  -  by @​ilyaliao and @​antfu in https://github.com/vueuse/vueuse/issues/4383 (ffa00)

    View changes on GitHub

v12.1.0

Compare Source

   🚀 Features

• createEventHook: Add clear function  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4378 (40265)
• useBase64: Add options for Data URL output control  -  by @​ilyaliao and Jelf in https://github.com/vueuse/vueuse/issues/4316 (4b4bd)
• useDeviceMotion: Add permission controls, improve destructure  -  by @​thefeymesaleng and @​antfu in https://github.com/vueuse/vueuse/issues/4127 (cf729)
• useElementVisibility: Add rootMargin option  -  by @​dritter and @​antfu in https://github.com/vueuse/vueuse/issues/4100 (3a928)
• useMediaControls: Add 'media' option to define media query for resources  -  by @​aaronLejeune in https://github.com/vueuse/vueuse/issues/4344 (209de)
• useRafFn: Allow framerate to be a reactive value  -  by @​OrbisK and Anthony Fu in https://github.com/vueuse/vueuse/issues/4409 (4759f)
• useSSRWidth: Add optional support for SSR in useMediaQuery and useBreakpoints  -  by @​Tofandel, Anthony Fu and @​antfu in https://github.com/vueuse/vueuse/issues/4317 (55965)
• useUrlSearchParams: Add writeMode options  -  by @​ishakhorski, Ivan Shakhorski and @​antfu in https://github.com/vueuse/vueuse/issues/4392 (2c972)
• useWebSocket: Introduce autoConnect options to control auto connections on url changes  -  by @​ilyaliao and @​antfu in https://github.com/vueuse/vueuse/issues/4417 (05e75)
• useWebsocket: Support ref or getter as message  -  by @​SnowGuest, Anthony Fu and @​antfu in https://github.com/vueuse/vueuse/issues/4116 (a72c0)
• useWindowSize: Add type: visual option that leverage visualViewport  -  by @​huiliangShen and @​antfu in https://github.com/vueuse/vueuse/issues/4395 (e78ef)

   🐞 Bug Fixes

• injectLocal: Allow inject to app context  -  by @​antfu (b08a9)
• useAsyncState: Use ShallowRef instead of Ref type  -  by @​joris-gallot and Anthony Fu in https://github.com/vueuse/vueuse/issues/4294 (4d0a7)
• useDropZone: Update type to allow readonly array param  -  by @​briankchan in https://github.com/vueuse/vueuse/issues/4319 (df363)
• useFetch: Handle empty payload  -  by @​ilyaliao in https://github.com/vueuse/vueuse/issues/4366 (8a89d)
• useMediaQuery: The return value should be computed  -  by @​alexzhang1030 and @​antfu in https://github.com/vueuse/vueuse/issues/4403 (3af75)
• useRouteParams,useRouteQuery: Set route param/query to undefined when defaultValue is ref or getter  -  by @​vojvodics and Anthony Fu in https://github.com/vueuse/vueuse/issues/3977 (23fdb)
• useScroll: To properly report arriveState for elastic scroll  -  by @​719media and Anthony Fu in https://github.com/vueuse/vueuse/issues/4133 (90ff4)
• useTextareaAutosize: Make input required  -  by @​axuj, @​antfu and Anthony Fu in https://github.com/vueuse/vueuse/issues/4129 (25ed2)
• useWebNotification: Prevent notifications when checking for support  -  by @​9romise in https://github.com/vueuse/vueuse/issues/4019 (01f92)
• useWebSocket: Close socket connection inside WebWorker fix  -  by @​catz in https://github.com/vueuse/vueuse/issues/4229 (ece6a)

    View changes on GitHub

v12.0.0

Compare Source

   🚨 Breaking Changes

• Drop Vue 2 support, optimize bundles and clean up  -  by @​antfu in https://github.com/vueuse/vueuse/issues/4349 (0a9ed)

[!NOTE]
To Vue 3 users, v12.0.0 is equivalent to v11.3.0 on behaviors, only to remove some Vue 2 specific handling and will be slightly lighter. We expect future development to contain on v12.x and forward, and only backport if there are security issues. This means that VueUse would no longer be active on Vue 2 support.

    View changes on GitHub